chore: Remove setup.py by Dor-bl · Pull Request #1218 · appium/python-client

Dor-bl · 2026-04-17T21:26:43Z

This pull request modernizes the packaging and installation process for the Appium Python client by removing legacy setup.py support and updating documentation and versioning configuration. The main focus is on fully adopting PEP 517/518 standards with pyproject.toml and streamlining version management.

Packaging and Installation Modernization:

Removed the legacy setup.py file, fully transitioning to pyproject.toml and PEP 517/518 standards for building and installing the package.
Updated installation instructions in README.md to use pip install . instead of python setup.py install, reflecting modern Python packaging best practices.

Version Management Improvements:

Simplified version retrieval in appium/version.py by directly using importlib.metadata.version, removing unnecessary indirection.
Updated pyproject.toml to synchronize versioning between pyproject.toml and appium/version.py for better consistency with semantic release tooling.
Removed the [tool.hatch.version] section from pyproject.toml, as version management is now handled elsewhere.

- Completely remove setup.py. - Bump major version of the package to 6.0.0. - Update appium/version.py with a static version string for consistency. - Sync pyproject.toml and appium/version.py via semantic-release configuration. - Update CHANGELOG.md.

mykola-mokhnach · 2026-04-18T21:15:17Z

Some more AI findings:

py.typed: The shim explicitly ships package_data={'appium': ['py.typed']}. Hatch does not repeat that in TOML; in practice Hatchling usually includes non-Python files under an explicitly listed package directory, but this is worth one verification (inspect a built wheel for appium/py.typed) if you rely on PEP 561 at install time.

Docs / muscle memory: [README.md](README.md) still mentions python setup.py install; removing setup.py means those instructions should point to pip install / uv pip install instead.

…ctly

Dor-bl · 2026-04-18T21:32:06Z

Some more AI findings:

py.typed: The shim explicitly ships package_data={'appium': ['py.typed']}. Hatch does not repeat that in TOML; in practice Hatchling usually includes non-Python files under an explicitly listed package directory, but this is worth one verification (inspect a built wheel for appium/py.typed) if you rely on PEP 561 at install time.

Docs / muscle memory: [README.md](README.md) still mentions python setup.py install; removing setup.py means those instructions should point to pip install / uv pip install instead.

py.typed: Confirmed it's included in the built wheel. Hatchling automatically picks up all files under the appium package directory, so no extra config is needed.
README.md: Replaced both python setup.py install references with pip install . in the source install instructions (lines 29 and 37).

Copilot

Pull request overview

This PR modernizes the project’s packaging/versioning by removing the legacy setup.py flow and shifting installation guidance to pip install ., while attempting to align version management with pyproject.toml and semantic-release.

Changes:

Removed setup.py to fully rely on pyproject.toml/PEP 517 builds.
Updated pyproject.toml semantic-release settings and removed Hatch’s version config.
Changed runtime version retrieval in appium/version.py and updated README install commands.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
setup.py	Removed legacy setuptools entrypoint.
pyproject.toml	Removes Hatch version config; updates semantic-release version sync settings.
appium/version.py	Changes how the package version is resolved at runtime.
README.md	Replaces `python setup.py install` with `pip install .`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-19T09:57:19Z

+from importlib.metadata import version as _metadata_version

-
-def _get_version():
-    return metadata.version('Appium-Python-Client')
-
-
-version = _get_version()
+version = _metadata_version('Appium-Python-Client')


version = _metadata_version('Appium-Python-Client') will raise importlib.metadata.PackageNotFoundError when the distribution metadata is not available (e.g., running from a source checkout without an installed wheel/sdist), which makes importing appium.version fail. Wrap the metadata lookup in a try/except and fall back to a safe value (the PR description mentions returning 'unknown').

the PR description needs to be updated

Copilot · 2026-04-19T09:57:19Z

+from importlib.metadata import version as _metadata_version

-
-def _get_version():
-    return metadata.version('Appium-Python-Client')
-
-
-version = _get_version()
+version = _metadata_version('Appium-Python-Client')


The PR description says _get_version() was improved to handle missing package metadata and return 'unknown', but _get_version() was removed and the module now unconditionally queries metadata at import time. Either reintroduce a helper with the documented fallback behavior or adjust the PR description to match the implemented behavior.

same as above

Copilot · 2026-04-19T09:57:19Z

 no_git_verify = false
 tag_format = "v{version}"
-version_toml = ["pyproject.toml:project.version"]
+version_toml = ["pyproject.toml:project.version", "appium/version.py:version"]


version_toml is configured to update appium/version.py:version, but version_toml entries are typically TOML key paths (and appium/version.py is not a TOML file). If the intent is to have python-semantic-release bump a Python variable, use the configuration option intended for Python version variables (and ensure appium/version.py contains a literal version string assignment that the tool can rewrite). Otherwise the release process may fail when trying to parse/update this entry.

Suggested change

version_toml = ["pyproject.toml:project.version", "appium/version.py:version"]

version_toml = ["pyproject.toml:project.version"]

version_variables = ["appium/version.py:version"]

makes sense to me

Removed appium/version.py:version from version_toml. Since version.py now reads the version dynamically from installed package metadata (importlib.metadata), python-semantic-release only needs to bump the version in pyproject.toml - the runtime value follows automatically.

Dor-bl and others added 4 commits April 7, 2026 05:00

chore: update appium-python-client version to 6.0.0

84a871c

chore: update CHANGELOG for v6.0.0 release, removing setup.py details

b8f443b

refactor: update version retrieval to use importlib.metadata

261dfc0

Dor-bl changed the title ~~Remove setup.py and release version 6.0.0 with updates~~ Chore: Remove setup.py and release version 6.0.0 with updates Apr 17, 2026

Dor-bl changed the title ~~Chore: Remove setup.py and release version 6.0.0 with updates~~ chore: Remove setup.py and release version 6.0.0 with updates Apr 17, 2026

KazuCocoa requested changes Apr 18, 2026

View reviewed changes

Comment thread pyproject.toml Outdated

chore: revert version to 5.3.0 in pyproject.toml and uv.lock

94b11a9

Dor-bl changed the title ~~chore: Remove setup.py and release version 6.0.0 with updates~~ chore: Remove setup.py Apr 18, 2026

mykola-mokhnach reviewed Apr 18, 2026

View reviewed changes

Comment thread appium/version.py Outdated

Dor-bl added 2 commits April 18, 2026 23:28

refactor: simplify version retrieval by using importlib.metadata dire…

5456ae5

…ctly

chore: update installation instructions to use pip instead of setup.py

b6a2fad

Dor-bl added 2 commits April 18, 2026 23:33

refactor: remove unused PackageNotFoundError import from version.py

1a42805

refactor: remove unnecessary blank line in version.py

7a459ab

eglitise requested a review from Copilot April 19, 2026 09:54

Copilot started reviewing on behalf of eglitise April 19, 2026 09:54 View session

Copilot AI reviewed Apr 19, 2026

View reviewed changes

chore: remove appium/version.py from version_toml in pyproject.toml

902e116

KazuCocoa approved these changes Apr 19, 2026

View reviewed changes

KazuCocoa mentioned this pull request Apr 19, 2026

Stop auto release til merge all of TODO: Remove the fallback removal #1221

Open

KazuCocoa merged commit 0f549c3 into appium:master Apr 19, 2026
12 of 13 checks passed

	version_toml = ["pyproject.toml:project.version", "appium/version.py:version"]
	version_toml = ["pyproject.toml:project.version"]
	version_variables = ["appium/version.py:version"]

Conversation

Dor-bl commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mykola-mokhnach commented Apr 18, 2026

Uh oh!

Dor-bl commented Apr 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

mykola-mokhnach Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Dor-bl Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

mykola-mokhnach Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Dor-bl Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

mykola-mokhnach Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Dor-bl Apr 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Dor-bl commented Apr 17, 2026 •

edited

Loading

Dor-bl commented Apr 18, 2026 •

edited

Loading